<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <meta http-equiv="Content-Style-Type" content="text/css">
  <title>Geeklog {plugin} plugin Guide</title>
  <link rel="stylesheet" type="text/css" href="../style.css" title="Doc Stylesheet">
</head>

<body>
  <a name="top"></a>
  <h1>Geeklog {plugin} plugin</h1>
  <dl>
    <dt>Author</dt><dd>{author_name} &lt;{author_email}&gt;</dd>
    <dt>Version</dt><dd>1.0.0</dd>
    <dt>Date</dt><dd>2010-04-12</dd>
    <dt>License</dt><dd>GPLv2 or later</dd>
    <dt>Requirements</dt><dd><strong>Geeklog-{gl_version} or later</strong></dd>
  </dl>

  <a name="introduction"></a>
  <h2>Introduction</h2>
  <p>Geeklog {display_name} plugin, {display_name} provides for.</p>

  <div class="back_to_top"><a href="#top">Back to TOP</a></div>

  <a name="install"></a>
  <h2>Installation</h2>

  <p>In the description below:</p>
  <ul>
    <li><span class="geeklog">&lt;geeklog_dir&gt;</span> is a folder (directory) in which Geeklogs's <tt>db-config.php</tt> resides</li>
    <li><span class="public">&lt;public_html&gt;</span> is a folder (directory) in which <tt>lib-common.php</tt> resides</li>
    <li><span class="admin">&lt;admin&gt;</span> is a folder (directory) in which files for admin resides (Usually, the child directory of <span class="public">&lt;public_html&gt;</span>)</li>
  </ul>

  <ol>
    <li>Back up your database by using admin's database utility or a GUI tool like phpMyAdmin, since {plugin} plugin modifies the database.</li>
    <li>Unpack a archive file of the plugin into <span class="geeklog">&lt;geeklog_dir&gt;</span>/plugins folder.  A folder named <tt>{plugin}</tt> will be created in the <tt>plugins</tt> folder.</li>
    <li>In the <span class="public">&lt;public_html&gt;</span>/ folder, create a folder named <tt>{plugin}</tt>, and in the <span class="admin">&lt;admin&gt;</span>/plugins/ folder, create a folder named <tt>{plugin}</tt> as well.</li>
    <li>Move to <span class="geeklog">&lt;geeklog_dir&gt;</span>/plugins/{plugin}/ folder and copy all the contents of the <tt>public_html</tt> folder into the <span class="public">&lt;public_html&gt;</span>/{plugin} folder you created in the previous step.  Likewise, copy all the contents of the <tt>admin</tt>folder into the <span class="admin">&lt;admin&gt;</span>/plugins/{plugin}/ folder.</li>
    <li>Log in to your site as admin, go to the plugin editor and click on the "{plugin}" link.  When installation failed, please check the error log (<span class="geeklog">&lt;geeklog_dir&gt;</span><tt>/logs/error.log</tt>).</li>
  </ol>

  <div class="back_to_top"><a href="#top">Back to TOP</a></div>

  <a name="how_to_use"></a>
  <h2>Usage</h2>

  <h3>1. Using one sample</h3>

  <p>Enter a description of how to use here.</p>

  <h3>2. Using two sample</h3>

  <p>Enter a description of how to use here.</p>

  <div class="back_to_top"><a href="#top">Back to TOP</a></div>

  <a name="uninstall"></a>
  <h2>Uninstallation</h2>

  <ol>
    <li>Log in to your site as admin, go to the plugin editor and click on the "{plugin}" link.  All relevant database data will be erased.</li>
    <li>Then, remove the three folders you created when installing the plugin: <span class="geeklog">&lt;geeklog-dir&gt;</span>/plugins/{plugin}/, <span class="public">&lt;public_html&gt;</span>/{plugin}/ and <span class="admin">&lt;admin&gt;</span>/plugins/{plugin}/.</li>
  </ol>

  <div class="back_to_top"><a href="#top">Back to TOP</a></div>

  <a name="history"></a>
  <h2>History</h2>
  <table summary="revision history of the {plugin} plugin">
    <tr class="header">
      <th>Date(YYYY-MM-DD)</th><th>Version</td><th>Description</th>
    </tr>
    <tr>
      <td>2010-04-12</td><td>1.0.0</td>
      <td>
        <span class="new">[New]</span> First public release. <br>
        <span class="fix">[Fix]</span> Fixed sample.
      </td>
    </tr>
  </table>

  <p class="footer">2010 &copy; {author_name} at <a href="{pi_url}">{pi_url}</a> &nbsp; (docstyle at <a href="http://mystral-kk.net/">mystral-kk</a> & <a href="http://hiroron.com">hiroron</a>)</p>
</body>
</html>
